---
id: get-source
title: "Retrieve a source"
description: "Returns a source."
sidebar_label: "Retrieve a source"
hide_title: true
hide_table_of_contents: true
api:
  {
    "operationId": "getSource",
    "description": "Returns a source.",
    "tags": ["Sources"],
    "responses":
      {
        "200":
          {
            "description": "OK",
            "content":
              {
                "application/json":
                  {
                    "schema":
                      {
                        "type": "object",
                        "properties":
                          {
                            "type":
                              {
                                "description": "The type of the source.",
                                "type": "string",
                              },
                            "name":
                              {
                                "description": "The name of the source.",
                                "type": "string",
                              },
                            "createdAt":
                              {
                                "description": "An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp representing the date/time the source was created.",
                                "type": "string",
                                "format": "date-time",
                              },
                            "updatedAt":
                              {
                                "description": "An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp representing the date/time the source was updated.",
                                "type": "string",
                                "format": "date-time",
                              },
                            "connectionUrl":
                              {
                                "description": "The URL to the location of the source.",
                                "type": "string",
                                "format": "URL",
                              },
                            "description":
                              {
                                "description": "The description of the dataset.",
                                "type": "string",
                              },
                          },
                        "example":
                          {
                            "type": "POSTGRESQL",
                            "name": "my-source",
                            "createdAt": "2019-05-09T19:49:24.201361Z",
                            "updatedAt": "2019-05-09T19:49:24.201361Z",
                            "connectionUrl": "jdbc:postgresql://db.example.com/mydb",
                            "description": "My first source!",
                          },
                        "title": "Source",
                      },
                  },
              },
          },
      },
    "parameters":
      [
        {
          "name": "source",
          "in": "path",
          "description": "The name of the source.",
          "required": true,
          "schema":
            { "type": "string", "maxLength": 1024, "example": "my-source" },
        },
      ],
    "method": "get",
    "path": "/sources/{source}",
    "servers":
      [
        {
          "url": "http://localhost:5000/api/v1",
          "description": "Local API server",
        },
      ],
    "info":
      {
        "title": "Marquez",
        "version": "0.50.0",
        "description": "Marquez is an open source **metadata service** for the **collection**, **aggregation**, and **visualization** of a data ecosystem's metadata.",
        "license":
          {
            "name": "Apache 2.0",
            "url": "http://www.apache.org/licenses/LICENSE-2.0.html",
          },
      },
    "postman":
      {
        "name": "Retrieve a source",
        "description": { "content": "Returns a source.", "type": "text/plain" },
        "url":
          {
            "path": ["sources", ":source"],
            "host": ["{{baseUrl}}"],
            "query": [],
            "variable":
              [
                {
                  "disabled": false,
                  "description":
                    {
                      "content": "(Required) The name of the source.",
                      "type": "text/plain",
                    },
                  "type": "any",
                  "value": "",
                  "key": "source",
                },
              ],
          },
        "header": [{ "key": "Accept", "value": "application/json" }],
        "method": "GET",
      },
  }
sidebar_class_name: "get api-method"
info_path: docs/api/marquez
custom_edit_url: null
---

import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## Retrieve a source

Returns a source.

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"source","in":"path","description":"The name of the source.","required":true,"schema":{"type":"string","maxLength":1024,"example":"my-source"}}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

OK

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The type of the source.","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the source.","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp representing the date/time the source was created.","type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp representing the date/time the source was updated.","type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"connectionUrl"} required={false} schemaName={"URL"} qualifierMessage={undefined} schema={{"description":"The URL to the location of the source.","type":"string","format":"URL"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The description of the dataset.","type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"type\": \"POSTGRESQL\",\n  \"name\": \"my-source\",\n  \"createdAt\": \"2019-05-09T19:49:24.201361Z\",\n  \"updatedAt\": \"2019-05-09T19:49:24.201361Z\",\n  \"connectionUrl\": \"jdbc:postgresql://db.example.com/mydb\",\n  \"description\": \"My first source!\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>

